docs: add warning about API server OIDC configuration#4641
docs: add warning about API server OIDC configuration#4641zyzzmohit wants to merge 1 commit intokubernetes-sigs:mainfrom
Conversation
Signed-off-by: zyzzmohit <mohitray949@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: zyzzmohit The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Pull request overview
Updates the in-cluster OIDC installation docs to clearly state that Headlamp OIDC login requires the Kubernetes API server to be configured to validate OIDC tokens, addressing a common setup gap reported in #4618.
Changes:
- Added an “Important” warning callout near the top of the OIDC in-cluster installation doc, with a link to the official Kubernetes OIDC token documentation.
- Removed an extra blank line in the Entra ID quick reference section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Maybe what you have is ok and fine enough. But I’m a bit unclear about the conditions that bring people here. Maybe you can help me understand? How will people find this? What happens if it’s not? Maybe we can the error behavior here for folks to search for it. I’m also wondering if those docs are adequate for folks configuring a cloud k8s instance? Or is this not something they will encounter? Not like below(the details are probably wrong), but I think add the error condition they encounter to what you have and a note how to do this on a cloud provider is cloud provider specific (if it’s relevant at all to them?)
Or maybe what you have already is better, and these two things are not needed. |
|
@mlbiam this PR enough for the issue you reported? |
|
I wonder if we can add into an error message into headlamp when people encounter this something like: “Have you configured your api server? If not see: xxx” |
|
Summary
This PR updates the OIDC installation documentation to explicitly state that the Kubernetes API server must be configured to accept OIDC tokens. This addresses confusion where users configure Headlamp for OIDC but forget the underlying cluster configuration.
Related Issue
Fixes #4618
Changes
docs/installation/in-cluster/oidc.mdlinking to the official Kubernetes OIDC documentation.Preview